Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #38: Incorporate Finesse Benchmarking Tool #39

Merged
merged 23 commits into from
Feb 26, 2024

Conversation

ibrahim-kabir
Copy link
Contributor

@ibrahim-kabir ibrahim-kabir commented Feb 6, 2024

Tasks

Command Line Interface (CLI) Implementation

  • Implement CLI parsing for single command input.
  • Handle mandatory and optional arguments
  • CLI prints

Accuracy Score Calculation

  • Compare expected Q&A pages with Finesse response pages.
  • Calculate accuracy score for each response based on document's position in the results.
  • Implement scoring ranging from 0 to 1.0.

Round trip time

  • Calculate the round trip time

Statistical summary

  • Calculate a statistical summary of both Accuracy score and round trip time

Output

  • CSV saving function
  • md saving function

Documentation

  • Write clear and concise documentation for the tool.
  • Provide usage examples and explanations for each command-line argument.

Acceptance criteria

  • Facilitate Comparative Evaluation of Search Engines
  • Provide Accurate and Actionable Results
  • Facilitate Search Engine Development and Optimization

@ibrahim-kabir ibrahim-kabir linked an issue Feb 6, 2024 that may be closed by this pull request
2 tasks
@ibrahim-kabir ibrahim-kabir self-assigned this Feb 6, 2024
@ibrahim-kabir
Copy link
Contributor Author

@rngadam DESIGN.md is ready for review

@rngadam
Copy link

rngadam commented Feb 6, 2024

discussed verbally with @ibrahim-kabir about accuracy vs efficiency, researching existing python api benchmarking tools, output formats (csv, markdown)

@ibrahim-kabir ibrahim-kabir changed the title Issue #38: Incorporate Finesse Test Tool Issue #38: Incorporate Finesse Test Script Feb 7, 2024
@ibrahim-kabir ibrahim-kabir changed the title Issue #38: Incorporate Finesse Test Script Issue #38: Incorporate Finesse Benchmarking Tool Feb 7, 2024
@ibrahim-kabir
Copy link
Contributor Author

@rngadam DESIGN.md has been reworked, adding eventual tools (locust is really promising), statistical summaries and reviewed my vocabulary choices.
It is ready for review.

Copy link

@rngadam rngadam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggest trying locust

api-test/DESIGN.md Outdated Show resolved Hide resolved
Copy link

@JolanThomassin JolanThomassin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really good document, well explained, good diagram too. Just maybe unsure about the name of the markdown file.

api-test/DESIGN.md Show resolved Hide resolved
@rngadam rngadam requested a review from leejaeka February 9, 2024 16:50
@ibrahim-kabir ibrahim-kabir marked this pull request as ready for review February 16, 2024 16:55
@ibrahim-kabir
Copy link
Contributor Author

Test result and results analysis are documented on the Finesse accuracy test results wiki page

Copy link

@rngadam rngadam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small changes otherwise good to merge (and then move to api-test)

.devcontainer/devcontainer.json Outdated Show resolved Hide resolved
.devcontainer/devcontainer.json Outdated Show resolved Hide resolved
api-test/DESIGN.md Outdated Show resolved Hide resolved
api-test/DESIGN.md Outdated Show resolved Hide resolved
api-test/jsonreader.py Outdated Show resolved Hide resolved
api-test/locustfile.py Outdated Show resolved Hide resolved
Copy link

@JolanThomassin JolanThomassin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look good to me

@ibrahim-kabir ibrahim-kabir merged commit 3c0dd44 into main Feb 26, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Evaluate Finesse Accuracy using Generated Q&A
3 participants